Skip to main content

GetRows

Returns a Range object that represents the rows in the specified range. If the specified row is outside the Range object, a new Range will be returned that represents the cells between the columns of the original range in the specified row.

Syntax​

expression.GetRows(nRow);

expression - A variable that represents a ApiRange class.

Parameters​

NameRequired/OptionalData typeDefaultDescription
nRowRequirednumberThe row number (starts counting from 1, the 0 value returns an error).

Returns​

ApiRange | null

Example​

This example shows how to get a Range object that represents the rows in the specified range.

var oWorksheet = Api.GetActiveSheet();
var oRange = oWorksheet.GetRange("1:3");
for (var i=1; i <= 3; i++) {
	var oRows = oRange.GetRows(i);    
	oRows.SetValue(i);
}